OPC Studio User's Guide and Reference
ReadItem<TValue>(IEasyDAClient,ServerDescriptor,DANodeDescriptor,DAReadParameters) Method



OpcLabs.EasyOpcClassicCore Assembly > OpcLabs.EasyOpc.DataAccess.Extensions Namespace > IEasyDAClientExtension2 Class > ReadItem Method : ReadItem<TValue>(IEasyDAClient,ServerDescriptor,DANodeDescriptor,DAReadParameters) Method
The type of item value.
The client object that will perform the operation.

This is typically the OpcLabs.EasyOpc.DataAccess.EasyDAClient object.

The value of this parameter cannot be null (Nothing in Visual Basic).

The OPC server involved in the operation.

Because the OpcLabs.EasyOpc.ServerDescriptor has an implicit conversion from System.Guid, System.String and OpcLabs.EasyOpc.ServerElement, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a GUID (representing the CLSID of the server), a string (representing the so-called OPC server descriptor string, such as a ProgID or the URL of the server), or a OpcLabs.EasyOpc.ServerElement object (result from OPC browsing), in place of this parameter, and the corresponding OPC server descriptor will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the OpcLabs.EasyOpc.ServerDescriptor.FromGuid, OpcLabs.EasyOpc.ServerDescriptor.FromString or OpcLabs.EasyOpc.ServerDescriptor.FromServerElement static method instead.

The value of this parameter cannot be null (Nothing in Visual Basic).

The OPC item involved in the operation.

Because the OpcLabs.EasyOpc.DataAccess.DANodeDescriptor has an implicit conversion from System.String and OpcLabs.EasyOpc.DataAccess.AddressSpace.DANodeElement, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a string (representing the qualified name of the node), or a OpcLabs.EasyOpc.DataAccess.AddressSpace.DANodeElement object (result from OPC browsing), in place of this parameter, and the corresponding OPC DA node descriptor will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the FromString or FromDANodeElement static method instead.

The value of this parameter cannot be null (Nothing in Visual Basic).

Read parameters, such as the data source or value age.

Because the OpcLabs.EasyOpc.DataAccess.DAReadParameters has an implicit conversion from System.Int32 and OpcLabs.EasyOpc.DataAccess.DADataSource, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use an integer (representing the value age in milliseconds), or an element of the OpcLabs.EasyOpc.DataAccess.DADataSource enumeration in place of this parameter, and the corresponding OPC DA read parameters object will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the DAReadParameters Constructor(Int32) or DAReadParameters Constructor(DADataSource) constructor instead.

The value of this parameter cannot be null (Nothing in Visual Basic).

Reads a typed named item using descriptor objects for the OPC server and OPC-DA item, and specifying read parameters such as the data source or value age.
Syntax
'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Overloads Shared Function ReadItem(Of TValue)( _
   ByVal client As IEasyDAClient, _
   ByVal serverDescriptor As ServerDescriptor, _
   ByVal nodeDescriptor As DANodeDescriptor, _
   ByVal readParameters As DAReadParameters _
) As DAVtq(Of TValue)
'Usage
 
Dim client As IEasyDAClient
Dim serverDescriptor As ServerDescriptor
Dim nodeDescriptor As DANodeDescriptor
Dim readParameters As DAReadParameters
Dim value As DAVtq(Of TValue)
 
value = IEasyDAClientExtension2.ReadItem(Of TValue)(client, serverDescriptor, nodeDescriptor, readParameters)

Parameters

client
The client object that will perform the operation.

This is typically the OpcLabs.EasyOpc.DataAccess.EasyDAClient object.

The value of this parameter cannot be null (Nothing in Visual Basic).

serverDescriptor
The OPC server involved in the operation.

Because the OpcLabs.EasyOpc.ServerDescriptor has an implicit conversion from System.Guid, System.String and OpcLabs.EasyOpc.ServerElement, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a GUID (representing the CLSID of the server), a string (representing the so-called OPC server descriptor string, such as a ProgID or the URL of the server), or a OpcLabs.EasyOpc.ServerElement object (result from OPC browsing), in place of this parameter, and the corresponding OPC server descriptor will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the OpcLabs.EasyOpc.ServerDescriptor.FromGuid, OpcLabs.EasyOpc.ServerDescriptor.FromString or OpcLabs.EasyOpc.ServerDescriptor.FromServerElement static method instead.

The value of this parameter cannot be null (Nothing in Visual Basic).

nodeDescriptor
The OPC item involved in the operation.

Because the OpcLabs.EasyOpc.DataAccess.DANodeDescriptor has an implicit conversion from System.String and OpcLabs.EasyOpc.DataAccess.AddressSpace.DANodeElement, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a string (representing the qualified name of the node), or a OpcLabs.EasyOpc.DataAccess.AddressSpace.DANodeElement object (result from OPC browsing), in place of this parameter, and the corresponding OPC DA node descriptor will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the FromString or FromDANodeElement static method instead.

The value of this parameter cannot be null (Nothing in Visual Basic).

readParameters
Read parameters, such as the data source or value age.

Because the OpcLabs.EasyOpc.DataAccess.DAReadParameters has an implicit conversion from System.Int32 and OpcLabs.EasyOpc.DataAccess.DADataSource, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use an integer (representing the value age in milliseconds), or an element of the OpcLabs.EasyOpc.DataAccess.DADataSource enumeration in place of this parameter, and the corresponding OPC DA read parameters object will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the DAReadParameters Constructor(Int32) or DAReadParameters Constructor(DADataSource) constructor instead.

The value of this parameter cannot be null (Nothing in Visual Basic).

Type Parameters

TValue
The type of item value.

Return Value

If successful, the function returns a OpcLabs.EasyOpc.DataAccess.Generic.DAVtq<TValue> object. The object contains the value, timestamp and quality of the OPC item requested.

This method never returns null (Nothing in Visual Basic).

Exceptions
ExceptionDescription

A null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.

This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

The OPC "Classic" (or OPC XML-DA) operation has failed. This operation exception in uniformly used to allow common handling of various kinds of errors. The System.Exception.InnerException always contains information about the actual error cause.

This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.

Remarks

This is an extension method (info: C#, VB.NET). In languages that have support for extensions methods (such as C# and VB.NET), you can use the extension method as if it were a regular method on the object that is its first parameter. In other languages (such as with Python.NET), you will call the extension as a static method, and pass it the object on which it acts as its first parameter.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

See Also